Configuring the Master Parameters (master.props)
You can change the properties of the Master that were set during installation, as circumstances may force you to change the configuration of the Master as it was originally installed.
The properties of the Master are managed in a file called master.props that resides in the config directory on the Master machine. See the “Parameters” chapter in the Tidal Automation User Guide for more information about system parameters.
The master.props file on the Master looks like this:
JdbcURL=jdbc:sqlserver://SJC-Q8-WVM3:1433;responseBuffering=adaptive JdbcDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver Classpath=${TIDAL_HOME}\lib\Scheduler.jar;${TIDAL_HOME}\lib\sqljdbc.jar;${TIDAL_HOME}\lib\ojdbc14.j ar;${CLASSPATH}
CMDMasterPort=6600 JAVA_HOME=C:\Program Files\Java\jre6 JVMARGS=-Xms1024m -Xmx2048m
You change the configuration properties of the Master by manually adding a new property or modifying the value for an existing property. Be careful when changing the properties of the Master. Incorrect entries to the master.props file may prevent the proper operation of the Master. Do not add a Master property to the master.props file and leave it blank after the equals (=) sign.
The table in master.props properties contain a subset of the properties managed in the master.props file are listed below in alphabetical order.
master.props properties
Note: This is not a complete list.
Property |
Default |
What it controls |
---|---|---|
ActiveDirectory.Host |
company.com |
The Active Directory server URL. |
ActiveDirectory.Port |
389 |
The Active Directory server port. |
ActiveDirectory.GroupSearchPrefix |
OU=Group1,DC=company,D C=com |
The prefix of the AD node containing group records. The Master will scan these records when determining the groups to which a user belongs. |
ActiveDirectory.UserSearchPrefix |
OU=Group1,DC=company,D C=com |
The prefix of the AD node containing user records. The Master will scan these records when authenticating a user. |
ActiveDirectory.AuthenticationMethod |
simple |
The authentication method is required to connect to the directory to perform a directory lookup. Set to none if the directory can be looked up anonymously. Set to simple if the user and password are required to connect to the directory to perform a directory lookup. |
ActiveDirectory.BindUser |
|
The user that binds with Active Directory when the login user does not have permission to perform user search. |
ActiveDirectory.BindPassword |
|
The password for ActiveDirectory.BindUser. |
ActiveDirectory.DefaultDomain |
|
The Active Directory domain name should be prefixed to the username so that users can enter the username without a domain string when signing in to Tidal Automation. |
AdapterHostHeartbeat |
16 |
Specifies the interval (in seconds) the adapter host environment checks with the Master. |
AdapterHostMaxMemory |
256 |
Maximum size of Adapter host heap space in MBs. |
AdapterHostMinMemory |
64 |
Starting size of Adapter Host heap space in MBs. |
AdapterHostResendMsgInt |
60 |
Specifies the interval (in seconds) that the adapter host waits for a confirmation from the master that a message was received before resending the message again. |
AdapterHostServerPort |
6950 |
Port number used by the adapter host server. |
AdapterHostServicePort |
6980 |
Port number used by the adapter host service. |
AgentHeartBeatInt |
20 |
Seconds between heartbeats. The minimum is 15 seconds. Agent's equivalent is HB=<milliseconds> (It is in tagent.ini). |
AgentHeartbeatFailureCount |
6 |
The number of missed heartbeats allowed before declaring the connection bad. Minimum value is 3. |
AgentManagerLog |
SEVERE |
Sets the detail level for recording agents' messages to the Agent Manager log. |
AgentPort |
5591 |
Port number used by the master to communicate with the agent. |
AgentResendMsgInt |
600 |
Seconds after which an unasked message is resent to the Master. The minimum is 180 seconds. Agent's .prp equivalent is RS=<milliseconds>. |
AgentResendTimeTickInt |
60 |
Seconds to wait before syncing time with the master. The minimum is 20 seconds. Agent's .prp equivalent is TT=<milliseconds>. |
AgentTZCompileInt |
1200 |
Agent time shift amount (in seconds) that causes the master to recompile. -1 disables the recompile. |
APClient |
<AlarmPoint client name> |
Specifies the name of the AlarmPoint client. |
APParams |
<AlarmPoint parameters> |
Specify parameters for notification from the AlarmPoint server. |
APstartDir |
3 |
The directory path to the AlarmPoint agent file.
|
classpath |
|
The path to the packages used in the program. |
ClientManagerLog |
SEVERE |
Sets the level of detail for recording messages about TA activity to the Client Manager log. |
CLIENT.WARNING_LIMIT_MEMORY_UTILIZATION |
|
The (% of Used Heap Memory to Total Heap Memory) or the (% Used RAM to Total RAM) at which a warning message is displayed if this value is exceeded. Specify as a percentage. Permitted values are 0.1 to 100. |
CLIENT.WARNING_LIMIT_QUEUE_SIZE |
|
The queue size limit at which a warning message is displayed if this value is exceeded. Specify the queue size limit as an integer. |
CMDMasterPort |
6600 |
Number of the port the command line program uses to connect to the Master machine. |
CommThreads |
8 |
Number of communication threads at one time. |
CommunicationLog |
SEVERE |
Sets the level of detail for recording messages about defined connections and sockets to the Communications log. |
CompilerLog |
SEVERE |
Sets the level of detail for recording messages about the status of compiling production schedules to the Compiler log. |
CONNECTINTERVAL |
30 |
The maximum time (in seconds) should be spent attempting to re-establish connection if the SAP connection is lost. |
CONNINFOPOLL |
10 |
Interval of seconds between polls to the SAP application server to determine the connection load (available job slots). |
DatabaseConnections |
20 |
Number of connections from the master to the database allowed at once (does not affect cursor count). |
DatabaseLog |
SEVERE |
Sets the level of detail for recording database messages to the Database log. |
DatabaseReconnectAttempts |
10 |
Number of times the master will attempt to reconnect with the admiral database if disconnected. |
dbuser |
|
Used by these TESM commands to connect to the TA Master database:
|
DefaultLog |
0 |
Sets the level of detail for recording general messages to the default log. |
DirectoryMonitorInt |
10 |
Specifies the time interval (in seconds) for an agent to check directories for files (file events). |
DisplayPanel.Color |
<Color code> |
Enables setting the status bar with a specific color. If the properties are entered as blank values, the TA environment defaults to its original settings. The Google Web Toolkit (GWT) libraries accept the hex values (#RRGGBB). The libraries also accept major colors such as red, blue, green, and yellow. The GWT Graphics supports these 16 keyword color names: aqua, black, blue, fuchsia, grey, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow. |
DisplayPanel.Message |
<Custom Message> |
Enables setting a custom message in the status bar. If the properties are entered as blank values, the TA environment defaults to its original settings. |
DisplayPanel.FontColor |
<Color code> |
Enables setting a specific font color for messages in the status bar. If the properties are entered as blank values, the TA environment defaults to its original settings. The Google Web Toolkit (GWT) libraries accept the hex values (#RRGGBB). The libraries also accept major colors such as red, blue, green, and yellow. The GWT Graphics supports these 16 keyword color names: aqua, black, blue, fuchsia, grey, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow. |
EncryptAgent |
Y |
By default, the Master sends data to the agent in encrypted form, without need to specify this parameter. N disables encryption but you must restart Master service. |
ENCRYP_AGENT_PROP |
N |
Enables encryption of the agent communications. |
EventManagerLog |
SEVERE |
Sets the level of detail for recording event-related messages to the Event Manager log. |
FaultMonitorLog |
INFO |
Sets the level of detail for recording messages about the fault monitor to the Fault Monitor log. |
FaultToleranceLog |
INFO |
Sets the level of detail for recording messages about fault tolerance components to the Fault Tolerance log. |
FileMonitorInt |
2 |
Specifies the time interval (in seconds) for an agent to check for files. |
FMMasterPort |
6703 |
Port the master uses to connect to the fault monitor. |
FT_OPERATION |
AUTO |
Specifies how fault tolerance is configured. AUTO – The Primary Master and Backup Master are interchangeable; either can be active. If one fails and the other takes over, when the failed Master comes back online, it remains in standby mode. FIXED – The Primary Master role is fixed. If it fails, the Backup Master takes over only until the Primary Master comes back online. The Primary Master cannot run in standby mode. In this configuration, the system can never be fault tolerant if the Backup Master is in control. If a failover occurs, the Primary Master cannot be restarted until the Backup Master is stopped. |
MODE (Optional) |
|
In a fault tolerance setup, if the primary master has to be forced to start in a standalone mode, then Set MODE=ST. |
GWStartedTaskExclude |
None |
Any job names that match the criteria listed in the GWStartedTaskPrefix parameter but that should not be considered a Started Task are listed here. The jobs listed in this parameter continue to be considered JES jobs. Each prefix in the list is separated by a comma. |
GWStartedTaskPrefix |
None |
Any job names that match the criteria listed, will be monitored as Started Tasks unless explicitly excluded by GWStartedTaskExclude parameter. Each prefix in the list is separated by a comma. |
JAVA_HOME |
|
The path to the Java home directory. |
JdbcDriver |
<directory path> |
Database connection driver. |
JdbcURL |
<directory path> |
Database connect string. |
JDBGL |
1 |
Sets the debugging level for the z/OS Gateway adapter. |
JOBINTERCEPTINT |
10 |
Interval of seconds between checking the SAP intercepted jobs queue. |
JVMARGS |
|
Property that sets the JVM argument (Windows only). |
JobManagerLog |
SEVERE |
Sets the level of detail for recording messages about job status to the Job Manager log. |
LogDirectory |
<../log> |
Location to write log files. Default=${TIDAL_HOME}/log. |
LogFileSize |
1 (in MB) |
Maximum value is 512 (in MB). Specifies the size based on which the log file is rolled out. If the specified size is more than 512, it is reset to 512 automatically. |
LOGPKT |
N |
Enables the logging of network traffic between TA and the z/OS Gateway adapter. |
LDAP.AuthenticationMethod |
simple |
The authentication method required to connect to the directory to perform a directory lookup. Set to none if the directory can be looked up anonymously. Set to simple if the user and password are required to connect to the directory to perform a directory lookup. |
LDAP.BindUser |
|
Bind user is a user which is used to bind with LDAP, when login user does not have permission to do user search |
LDAP.BindPassword |
|
Bind password is a password for the bind user |
LDAP.UserSearchAttribute |
None |
Specifies an attribute which is not part of user DN. This attribute is used to search and locate a user. The located user’s DN is then utilized to authenticate the user to TA. |
masterID |
<master instance name> |
Specifies the name of the master instance to the OpenView adapter. This the same as the primary master alias. |
MaxLogFiles |
50 |
Number of logs to retain. Defaults to 50 if not specified. This an optional property. |
MessageBroker.SSL.ClientNode.verifyHostName |
true |
If set to false, turns off the TLS hostname verification for ActiveMQ clients. |
MessagePoolSize |
0 |
Message pool size |
MessageThreads |
8 |
Number of messages threads at one time. Minimum value is 3. Maximum value is 12. |
opcmsgPath |
<directory path> |
The path to the opcmsg.exe file installed on the master by HP OpenView to communicate with the OpenView Operations Message Browser. |
OraAppsDBConnection |
5 |
Specifies the maximum number of connections opened to the Oracle Applications database. |
ORADEBUG |
OFF |
Enables debugging for the Oracle Applications adapter. |
OUTPUT_SCAN_CASE_INSENSITIVE |
N |
When searching job output for designated text strings, converts TA scanning to case-insensitive. By default, the scanning of job output is case-sensitive. If the job output is large, setting this value may adversely affect memory and system performance. |
PSCheckServer |
Y |
Turns on/off checking of the Process TA’s heartbeat. |
PSDBConnection |
5 |
Specifies the maximum number of connections opened to the PeopleSoft database. |
PSFinalStatusWait |
0 (no status check) |
Specifies an interval of time (in seconds) before doing a secondary status check after detecting a “completed” status. This an additional buffer of time to accommodate those occasions when PeopleTools switches final status shortly after the job completes. This value can be subtracted from the PSWaitOutput value if parameters are used to delay output after completion. If this parameter is greater than 20 seconds, set the PSWaitOutput to 0. |
PSRunServerOption |
Any |
The default server the adapter should use to submit process requests when running PeopleTools version 8.45 and later. There are four options: 1– Any (default) 2 – Specific 3 – Specific OS 4 – Primary |
PSTimeout |
3 x the heartbeat stipulated in process server (180 seconds) |
The interval in seconds without a heartbeat before considering a connection to the PeopleSoft server lost. |
PSUseRunStatus |
N |
When running API aware processes in PeopleSoft and this parameter is set to Y, then ignore the PRCSRTNCODE value and use the RUNSTATUS to determine the status. |
PSWaitOutput |
30 |
Number of seconds to wait for PeopleSoft job output. |
QueueManagerLog |
SEVERE |
Sets the level of detail for recording messages about queue activity to the Queue Manager log. |
SaveReplacedTokens |
N |
Specifies if the resolved value of tokens should be saved to the database. The default setting is to not save the resolved value (N). Useful if using passwords as a variable value and you do not want the passwords to be visible to other users. |
SAPLAUNCHTRIES |
3 |
Number of attempts to try launching an SAP job before going to Error status. |
SAPOUTPUTTHREADS |
5 |
Number of concurrent output threads per SAP connection. Due to the potential length of job output, output has its own thread and opens its own connection to retrieve the output and closes the connection as soon as the output completes. This parameter prevents the output requests from exceeding the connections licensed by SAP. |
SAPOUTPUTTRIES |
5 |
Number of attempts to connect to the output server for SAP job output. |
SAPSERVERTIME |
D |
The default is to regularly poll the SAP server for the time. If N is specified, this time check polling of the SAP server is disabled. O specifies the old timecheck call. |
SAPTIMEOUT |
120 |
Number of seconds before the Remote Function Call (RFC) times out. |
SAPTIMEZONE |
N |
If Y is specified, TA will use the time zone where the SAP system resides when scheduling SAP jobs. This time difference is displayed in the Time Zone column of the Connections window. To use this parameter, enable “GET_SYSTEM_TIMEZONE” in the SAP system for remote access. |
SchedulerLog |
OFF |
Sets the level of detail for recording system level messages about the master to the master log. |
Security.Authoentication |
ActiveDirectory |
|
Security.Authentication.Ext.File |
user-auth.xml |
|
snmphost |
2 |
Name of the machine where the SNMP software was installed. |
snmpport |
5 |
Number of the port used by the SNMP software. |
SMTP.legacyConfig |
N |
Denotes that the Master supports SSL and Authentication. If the property is set to ‘Y’, the Master behaves similar to 6.3.1 release, where it just uses the SMTP Server, port (25) and return address, and ignores the newly added fields in the System Configuration dialog, namely, Use SSL/TLS, Authentication Required, and so on. |
ToleranceTime |
3 |
The maximum time allowed for heartbeats lost between FM and PM/BM before FM decides connection to PM/BM is lost. This assuming the connection is not lost yet. If the connection is lost already (i.e. physical disconnect, PM/BM shutdown, socket timeout, etc) then the FM will failover immediately. Thus ToleranceTime does not apply in the case when the master is shutdown. The FM will failover immediately since PM connection is lost. Note the rules for failover: the PM must lose connection to the FM and the BM to cause a failover. For example, if the PM loses connection to the FM but not the BM, a failover will not occur, because the BM will reject the FM's failover as it can still talk with the PM. |
TRACE |
0 (Off) |
A value of 1 turns on the trace function in SAP to collect diagnostic data into a file with an extension of .trc. |
VIRTUALHOSTVERIFICATIONPORT |
|
The Master uses this port to accept an incoming TCP connection request which is initiated by the Master process itself but is routed via the virtual host. |
WebServer.Port |
8080 |
Note that this different from WebServerPort. |
WebServerPort |
9999 |
Turns on a webserver that can be used to analyze the contents of the memory here: http://<mastername>:9999/data. |
Vault.Enabled |
N |
Indicates whether to enable or disable the Password Vault in TA. |
Vault.Server |
<none> |
Indicates the Server where the Password Vault is configured. |
Vault.Path |
<none> |
Indicates the path where the Password Vault is configured. |
Vault.WriteEnabled |
N |
Indicates if Runtime User Information to the password vault is designated as ReadOnly or WriteEnabled. |
Vault.TokenWriteEnabled |
N |
Indicates whether tokens are written to the password vault. |
Vault.AppRoleId |
- |
If app role is enabled, this the role id. Example: 356e9157-bc14-a5fa-5ddd-40117f4c99fd |
Vault.OpenTimeout |
- |
Indicates the open timeout in seconds. |
Vault.ReadTimeout |
- |
Indicates the read timeout in seconds. |
Vault.SslEnabled |
- |
Indicates whether the Password Vault is enabled through SSL. |
Vault.TrustStoreFile |
- |
Indicates the path to truststore file. |
Vault.refreshCacheRate |
- |
Indicates the time (in minutes) the cache will refresh with latest vault credentials. Default value is 5 minutes. |
Vault.PemFilePath |
- |
Indicates to open SSL from PEM file path. |
ActiveDirectory.Host |
company.com |
The Active Directory server URL. |
ActiveDirectory.Port |
389 |
The Active Directory server port. |
ActiveDirectory.GroupSearchPrefix |
OU=Group1,DC=company,D C=com |
The prefix of the AD node containing group records. The Master will scan these records when determining the groups to which a user belongs. |
ActiveDirectory.UserSearchPrefix |
OU=Group1,DC=company,D C=com |
The prefix of AD node containing user records. The Master will scan these records when authenticating a user. |
ActiveDirectory.AuthenticationMethod |
simple |
The authentication method required to connect to the directory to perform a directory lookup. Set to none if the directory can be looked up anonymously. Set to simple if the user and password are required to connect to the directory to perform a directory lookup. |
ActiveDirectory.BindUser |
|
The user that binds with Active Directory when the login user does not have permission to perform user search. |
ActiveDirectory.BindPassword |
|
The password for ActiveDirectory.BindUser. |
ActiveDirectory.DefaultDomain |
|
The Active Directory domain name to be prefixed to the username such that users can enter the username without a domain string when signing in to Tidal Automation. |
AdapterHostHeartbeat |
16 |
Specifies the interval (in seconds) that the adapter host environment checks with the Master. |